home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / share / doc / bluez / network-api.txt < prev    next >
Encoding:
Text File  |  2008-12-05  |  2.1 KB  |  87 lines
  1. BlueZ D-Bus Network API description
  2. ***********************************
  3.  
  4. Copyright (C) 2004-2008  Marcel Holtmann <marcel@holtmann.org>
  5.  
  6.  
  7. Network hierarchy
  8. =================
  9.  
  10. Service        org.bluez
  11. Interface    org.bluez.Network
  12. Object path    [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
  13.  
  14. Methods        string Connect(string uuid)
  15.  
  16.             Connect to the network device and return the network
  17.             device name. Examples of the device name are bnep0,
  18.             bnep1 etc.
  19.  
  20.             Possible errors: org.bluez.Error.AlreadyConnected
  21.                      org.bluez.Error.ConnectionAttemptFailed
  22.  
  23.         void Disconnect()
  24.  
  25.             Disconnect from the network device.
  26.  
  27.             To abort a connection attempt in case of errors or
  28.             timeouts in the client it is fine to call this method.
  29.  
  30.             Possible errors: org.bluez.Error.Failed
  31.  
  32.         dict GetProperties()
  33.  
  34.             Returns all properties for the interface. See the
  35.             properties section for available properties.
  36.  
  37. Signals        PropertyChanged(string name, variant value)
  38.  
  39.             This signal indicates a changed value of the given
  40.             property.
  41.  
  42. Properties    boolean Connected [readonly]
  43.  
  44.             Indicates if the device is connected.
  45.  
  46.         string Device [readonly]
  47.  
  48.             Indicates the network interface name when available.
  49.  
  50.         string UUID [readonly]
  51.  
  52.             Indicates the connection role when available.
  53.  
  54.  
  55. Network Hub/Peer/Router hierarchy
  56. =================
  57.  
  58. Service        org.bluez
  59. Interface    org.bluez.network.{Hub, Peer, Router}
  60. Object path    /org/bluez/{hci0,hci1,...}
  61.  
  62. Methods        dict GetProperties()
  63.  
  64.             Returns all properties for the GN/PANU/NAP server. See the
  65.             properties section for available properties.
  66.  
  67.         void SetProperty(string name, variant value)
  68.  
  69.             Changes the value of the specified property. Only
  70.             properties that are listed a read-write are changeable.
  71.             On success this will emit a PropertyChanged signal.
  72.  
  73.             Possible Errors: org.bluez.Error.DoesNotExist
  74.                      org.bluez.Error.InvalidArguments
  75.  
  76. Properties    string Name[readwrite]
  77.  
  78.             The Bluetooth network server name.
  79.  
  80.         boolean Enable[readwrite]
  81.  
  82.             Indicates if the server is Enabled/Disabled.
  83.  
  84.         string Uuid[readonly]
  85.  
  86.             The Bluetooth network server UUID 128 identification.
  87.